home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / bildschirmschoner / fracblanker / fracblank.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  11KB  |  195 lines
  1. @database FracBlank.guide
  2. @author "Olaf `Olsen' Barthel <olsen@sourcery.han.de>"
  3. @$VER: FracBlank.guide 1.0 (9.3.95)
  4. @node Main "FracBlank"
  5.                   A non-modular screen blanker utility for
  6.                    operating system release v3.0 or higher
  7.                        Written by Olaf `Olsen' Barthel
  8.                         Freeware, All Rights Reserved
  9.             Cosmic flame fractal code derived from original xlock
  10.                 program source code, Copyright 
  11.  1988-1991 by
  12.                              Patrick J. Naughton
  13.                            I.   @{" Introduction    " link Introduction}
  14.                            II.  @{" Installation    " link Installation}
  15.                            III. @{" Configuration   " link Configuration}
  16.                            IV.  @{" User interface  " link GUI}
  17.                            V.   @{" Troubleshooting " link Troubleshooting}
  18.                            VI.  @{" Credits         " link Credits}
  19. @endnode
  20. @node Introduction
  21. FracBlank is a veteran among all the screen blanker utilities available for
  22. the Amiga. I created the first version way back in 1991 when I finally came
  23. upon the real plane fractal algorithm employed by the X-Windows xlock
  24. program. In the years after its initial release the program was subsequently
  25. expanded until I really lost interest in it. To my surprise the fractal
  26. creation code was `recycled' over and over again in the ever growing legion
  27. of modular screen blanker packages available for the Amiga. Usually the
  28. blanker code was falsely attributed to Olaf Seibert, sometimes the author was
  29. reported as `unknown'.
  30.    Now, about three years after the last revision, I decided to upgrade the
  31. program to `modern' standards; in fact I needed a good screen blanker, but
  32. none of the packages currently available could satisfy my needs. Neither was
  33. as system friendly as it really should be and added more useless bells,
  34. whistles and gongs than I would admit `term'
  35. sports.
  36.                                       *
  37. FracBlank is yet another custom screen blanker created to live in symbiosis
  38. with Kickstart v3.0 (or higher) and the Commodities Exchange toolkit, similar
  39. to the Blanker utility, just more wonderful.
  40.    Apart from the usual job (turning the screen to black after a given period
  41. of time in order to prevent the phosphorus of your monitor from burning in)
  42. it will draw some neat patterns while mouse and keyboard are inactive.
  43.    The real plane fractal pattern algorithm comes from the September 1986
  44. issue of Scientific American, some of you who are familiar with X11 will know
  45. it from the popular xlock program. The patterns created may remind you of
  46. spiders' webs, lace or even Chladni's patterns formed by grains of sand
  47. strewn across a vibrating surface.
  48.    When I received a copy of the original xlock program source code I
  49. decided to add another fractal type known as cosmic flames. The patterns
  50. created by this algorithm ressemble cosmic nebuli, ferns, the traces left by
  51. subatomic particles in the cloudchamber or the fruitless attempts of a
  52. lecturer in particly physics at action-painting.
  53. @endnode
  54. @node Installation
  55. Here is how you install the program manually:
  56.  There are two different program versions supplied, called "FracBlank_ieee",
  57.   which will run on any Amiga model, and "FracBlank_fpu", which requires an
  58.   Amiga equipped with an 68020/68030/68040/68060 CPU and/or an 68881/882 FPU.
  59.   Pick the version you need and copy it into your SYS:WBStartup drawer.
  60.   Take care, the wrong version will crash your machine.
  61.  If the supplied "gtlayout.library" is not yet installed on your system,
  62.   copy it to your "Libs:" drawer.
  63. That's all, it's as simple as that.
  64. @endnode
  65. @node Configuration
  66. FracBlank can be started both from Shell and from Workbench. It sports a
  67. number of configurable parameters as follows:
  68.     @{b}CX_PRIORITY=<Pri>@{ub}
  69.     The commodities priority to assign this tool to. You may want to change
  70.     this value if there is more than one commodities tool running that uses
  71.     the same key sequences as FracBlank. The tool which has the higher
  72.     priority assigned will receive the keystrokes first.
  73.     @{b}CX_POPKEY=<Keywords>@{ub}
  74.     The keys to press to open the FracBlank control panel. The control
  75.     panel allows you to set the hotkeys, adjust the timeous, etc.
  76.     @{b}CX_POPUP=YES@{ub} or @{b}NO@{ub}
  77.     This is a boolean switch which determines whether FracBlank is to open
  78.     the control panel on startup or to remain quiet. Place @{b}YES@{ub} here to
  79.     open it.
  80.     @{b}BLANKSCREEN=<Keywords>@{ub}
  81.     The keys to depress to force the screen blanker to become active. If the
  82.     blanker is already running, pressing the keys will cause the pattern to
  83.     change.
  84.     Note: When in @{b}
  85. Random
  86. @{ub} mode, a pattern change only concerns the currently
  87.           active fractal type. The screen will be cleared, but the fractal
  88.           type will will not change
  89.     @{b}SAVESCREEN=<Keywords>@{ub}
  90.     In order to save the fractal pattern that is currently being displayed
  91.     in the clipboard, press this key combination. The image will be stored
  92.     in IFF-ILBM format in clipboard unit 0.
  93.     @{b}DISPLAYMODE=<Name>@{ub}
  94.     If you omit this keyword, FracBlank will use the default public screen
  95.     displaymode to open the fractal blanker screen. If you choose to provide
  96.     it, it must match one of the names displayed in the list of the
  97.     preferences program "ScreenMode", such as "PAL:HighRes".
  98.     @{b}DEPTH=<Number>@{ub}
  99.     If you omit this keyword the fractal blanker screen will open in the
  100.     maximum depth the display mode supports. Otherwise, it selects a
  101.     specific screen depth to use.
  102.     @{b}COLOUR=STATIC@{ub} or @{b}CYCLE@{ub}
  103.     Two colour modes are supported; when in @{b}STATIC@{ub} mode, the rendering colour
  104.     map will not change. @{b}CYCLE@{ub} causes the colour palette to slowly cycle
  105.     backwards.
  106.     @{b}FRACTAL=REALPLANE@{ub}, @{b}COSMICFLAME@{ub} or @{b}RANDOM@{ub}
  107.     FracBlank supports two different fractal types and a random mode which
  108.     selects either of these. To select real plane fractals, place @{b}REALPLANE@{ub}
  109.     here, to select cosmic flames, use @{b}COSMICFLAME@{ub}; any other name will
  110.     select the random mode.
  111.     @{b}SCREENTIMEOUT=<MM:SS>@{ub}
  112.     Here you enter the number of minutes that must pass before the screen
  113.     blanker is activated. For example, @{b}1:00@{ub} will activate the blanker after
  114.     one minute has elapsed with no mouse or keyboard input. Enter @{b}0:00@{ub} to
  115.     disable the screen blanker altogether.
  116.     @{b}PATTERNTIMEOUT=<MM:SS>@{ub}
  117.     After a certain timeout has elapsed while the blanker is active, the
  118.     screen will be cleared and the pattern will change. This is where you
  119.     enter the time that has to elapsed. Enter @{b}0:00@{ub} if you do not want the
  120.     pattern to change.
  121.     @{b}MAXRECURSION=<Number>@{ub}
  122.     The maximum recursion level the cosmic flame blanker is to use. Greater
  123.     values may yield better images.
  124.     @{b}MAXDOTS=<Number>@{ub}
  125.     The maximum number of dots the cosmic flame blanker is to draw before
  126.     the screen is cleared.
  127. @endnode
  128. @node GUI
  129. The user interface will open when you press the key combination specified
  130. using the @{b}CX_POPKEY@{ub} keyword, by default this is @{b}[Shift]-[F1]@{ub}.
  131. Please note that the interface requires "gtlayout.library" v9 or higher to
  132. be installed.
  133. The controls found in the configuration window correspond directly to the
  134. tooltypes and command parameters described under Configuration:
  135.              @{b}Screen timeout@{ub}  See @{"SCREENTIMEOUT" link Configuration}
  136.             @{b}Pattern timeout@{ub}  See @{"PATTERNTIMEOUT" link Configuration}
  137.                     @{b}Hot key@{ub}  See @{"CX_POPKEY" link Configuration}
  138.                @{b}Blank screen@{ub}  See @{"BLANKSCREEN" link Configuration}
  139.    @{b}Save screen to clipboard@{ub}  See @{"SAVESCREEN" link Configuration}
  140.                              These text entry fields are special,
  141.                              in that they automatically translate
  142.                              the key combinations you press into
  143.                              proper key codes, suitable for use
  144.                              with the Commodities Exchange
  145.                              toolkit.
  146.                              If you wish to enter text in `the
  147.                              usual fashion', press the @{b}[Caps Lock]@{ub}
  148.                              key.
  149.                @{b}Display mode@{ub}  This is where you select the screen
  150.                              display mode and depth to use when
  151.                              blanking the screen. Just pick the
  152.                              mode you need from the list and move
  153.                              the depth slider as needed.
  154.                 @{b}Colour mode@{ub}  See @{"COLOUR" link Configuration}
  155.                @{b}Fractal type@{ub}  See @{"FRACTAL" link Configuration}
  156.     @{b}Maximum recursion level@{ub}  See @{"MAXRECURSION" link Configuration}
  157.                @{b}Maximum dots@{ub}  See @{"MAXDOTS" link Configuration}
  158.                        @{b}Save@{ub}  Store the current configuration in
  159.                              the FracBlank icon.
  160.                        @{b}Hide@{ub}  Keep the current settings, close the
  161.                              configuration window.
  162.                        @{b}Quit@{ub}  Close the configuration window and
  163.                              terminate the program.
  164. @endnode
  165. @node Troubleshooting
  166. There are few problems with FracBlank I know of, here is a list:
  167. The fractals appear to be off-centre.
  168.   Sorry, there is nothing you can do about it, in fact I cannot
  169.   do anything about it either. This is how the fractals work, they
  170.   are not necessarily centered around the origin which with FracBlank
  171.   is placed in the centre of the screen.
  172. The colours don't appear to cycle.
  173.   They do, but the colours shift very smoothly in 256 colour mode.
  174.  Pressing the alt/amiga/shift/control keys does not stop the blanker.
  175.   Check your hotkeys, if they make use of the qualifiers the qualifier
  176.   keys won't stop the blanker.
  177.  Keys don't always show up in the text editing fields.
  178.   If you want to enter a specific key combination, press the @{b}[Caps Lock]@{ub}
  179.   key. Otherwise, you need to hold down a bunch of qualifier keys in addition
  180.   to the key you want to use. Put another way, simply pressing @{b}[Help]@{ub}
  181.   won't do anything, @{b}[Shift]-[Help]@{ub} however does.
  182. @endnode
  183. @node Credits
  184. FracBlank and gtlayout.library were hand-crafted by Olaf `Olsen' Barthel.
  185. It uses the cosmic flame code from Patrick J. Naughton's xlock program.
  186. The icon was designed by Martin Huttenloher
  187. If you wish send me comments on the program, here is my address:
  188.     Olaf Barthel
  189.     Brabeckstrasse 35
  190.     D-30559 Hannover
  191.     Federal Republic of Germany
  192. And my eMail address is:
  193.     olsen@sourcery.han.de
  194. @endnode
  195.